Skip to content

chore: create Plan category with JTBD and CQA 2.1 compliance#3099

Closed
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-plan-category
Closed

chore: create Plan category with JTBD and CQA 2.1 compliance#3099
gtrivedi88 wants to merge 1 commit into
eclipse-che:mainfrom
gtrivedi88:jtbd-plan-category

Conversation

@gtrivedi88
Copy link
Copy Markdown
Contributor

Summary

  • Create a new top-level Plan Antora module as part of the JTBD category restructure: Discover → Plan → Install → Administer
  • Move calculating-che-resource-requirements.adoc, running-at-scale.adoc, and installing-the-chectl-management-tool.adoc out of the Administration Guide into modules/plan/
  • Add WHY-first JTBD abstracts with [role="_abstract"] blocks per CQA 2.1
  • Add :page-aliases: for backward-compatible URL redirects
  • Update 16 cross-module xrefs across admin-guide pages, partials, examples, and overview module

Context

This is the second PR in the JTBD category restructure series:

  1. Discoverchore: create Discover category with JTBD restructure #3098
  2. Plan — this PR
  3. Promote Install — move Install to top-level (future PR)
  4. Administer — rename remaining admin guide content (future PR)

Test plan

  • Antora build succeeds with no broken xrefs
  • detect-unused-content.sh passes (no orphaned pages/examples/images)
  • Vale linting passes
  • Plan section appears in nav with 3 pages
  • Old URLs redirect via :page-aliases:

🤖 Generated with Claude Code

@gtrivedi88 gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners May 14, 2026 14:09
@gtrivedi88 gtrivedi88 requested a review from ibuziuk May 14, 2026 14:09
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

Click here to review and test in web IDE: Contribute

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 14, 2026

🎊 Navigate the preview: https://6a063cc152484fc29c7b4fde--eclipse-che-docs-pr.netlify.app 🎊

Move resource planning and CLI tool content out of Administration Guide
into a new top-level Plan module, following the JTBD category restructure:
Discover → Plan → Install → Administer.

- Create modules/plan/ with nav, pages, examples, and images
- Move calculating-che-resource-requirements, running-at-scale, and
  installing-the-chectl-management-tool to Plan module
- Add WHY-first JTBD abstracts and [role="_abstract"] blocks
- Add :page-aliases: for backward-compatible URL redirects
- Update 16 cross-module xrefs across admin-guide, overview, and partials
- Register Plan module in antora.yml nav

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@gtrivedi88 gtrivedi88 force-pushed the jtbd-plan-category branch from f8fec79 to 483683d Compare May 14, 2026 20:32
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 14, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 18, 2026
Move all installation pages, partials, and examples from
administration-guide to a new modules/install/ module, matching the
downstream JTBD category structure. Create installation overview,
verification, and next-steps pages. Update all cross-module xrefs
and includes across admin-guide, overview, and end-user-guide.
Delete dissolved wrapper pages (preparing-the-installation,
permissions-to-install-che). Register discover, plan, and install
module navs in antora.yml.

Depends on: PR eclipse-che#3098 (Discover), PR eclipse-che#3099 (Plan)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
gtrivedi88 added a commit to gtrivedi88/che-docs that referenced this pull request May 18, 2026
Move calculating-che-resource-requirements, running-at-scale, and
installing-the-chectl-management-tool from administration-guide into
the install module. This merges what was planned as a separate Plan
module (PR eclipse-che#3099) directly into Install, matching the downstream
decision to retire the Plan guide.

- Move 3 pages, 4 examples, 1 image to modules/install/
- Add running-at-scale to install/nav.adoc Requirements section
- Update admin-guide nav to remove moved entries
- Convert cross-module xrefs: admin-guide refs to install become local
- Add plan: page-aliases for backward-compatible redirects

Co-authored-by: Cursor <cursoragent@cursor.com>
@gtrivedi88
Copy link
Copy Markdown
Contributor Author

Closing this PR. The Plan content (calculating-che-resource-requirements, running-at-scale, installing-the-chectl-management-tool) has been merged directly into the Install module in PR #3102 instead of creating a separate Plan module.

Rationale: The Plan guide contained only pre-installation infrastructure preparation content (resource sizing, scaling, CLI tooling). This fits naturally in the Install module's Requirements section rather than justifying a standalone top-level module. This aligns with the downstream decision to retire titles/plan/ and merge its content into the Installation guide.

The plan: page-aliases have been added to the moved pages in #3102 for backward-compatible redirects.

@gtrivedi88 gtrivedi88 closed this May 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant